Resource URL: /platform/<<version=1>>/snapshot/aliases/<SID>

    Overview: This resource applies the standard collection item pattern to
              individual OneFS snapshot aliases.  SID in the resource path is
              either the snapshot alias name (preferred) or alias ID.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve snapshot alias information.

       URL: GET /platform/<<version=1>>/snapshot/aliases/<SID>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "aliases": {
          "items": {
            "type": "object", 
            "properties": {
              "target_name": {
                "required": true, 
                "type": "string", 
                "description": "The name of the snapshot pointed to."
              }, 
              "created": {
                "required": true, 
                "type": "integer", 
                "description": "The Unix Epoch time the snapshot alias was created."
              }, 
              "target_id": {
                "required": true, 
                "type": "integer", 
                "description": "The ID of the snapshot pointed to."
              }, 
              "id": {
                "required": true, 
                "type": "integer", 
                "description": "The system ID given to the snapshot alias."
              }, 
              "name": {
                "required": true, 
                "type": "string", 
                "description": "The user or system supplied snapshot alias name."
              }
            }
          }, 
          "type": "array"
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify snapshot alias. All input fields are optional, but one or
            more must be supplied.

       URL: PUT /platform/<<version=1>>/snapshot/aliases/<SID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "name": {
      "type": "string", 
      "description": "The user or system supplied snapshot alias name."
    }, 
    "target": {
      "type": "string", 
      "description": "Target snapshot for this snapshot alias."
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete the snapshot alias

          URL: DELETE /platform/<<version=1>>/snapshot/aliases/<SID>

There are no query arguments for this method.

There is no JSON response body for this method.
